銀行振込(バーチャル口座)専有口座情報照会実行 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

ListVirtualaccount 専有口座一覧取得

加盟店様が保有するバーチャル口座をリスト形式で返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード

URL
/payment/ListVirtualaccount.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD
レスポンス
正常
BankCode 半角数字4桁
銀行コード
BranchCode 半角数字3桁
支店コード
AccountType 半角数字1桁 固定
預金種別
AccountNumber 半角数字7桁
口座番号
AccountStatus 半角英字32桁
口座状態

口座の状態を返却します。
UNUSED:未使用
TRADING:取引中(取引口座)
TRANSFERRED:入金済み(取引口座)
EXPIRED:有効期限切れ(取引口座)
ASSIGNED:継続口座ID割当中(継続口座)

ReserveID 半角英数32桁
継続口座ID

口座状態が"ASSIGNED"の場合、割り当てされている継続口座IDをセットします。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
BankCode=9998&BranchCode=999&AccountType=1&AccountNumber=1119999&AccountStatus=ASSIGNED&ReserveID=12345
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

InquiryVirtualaccountTransfer 入金履歴情報取得

指定したバーチャル口座に対する入金の履歴情報を返却します。
継続口座IDもしくは口座情報(BankCode,BranchCode,AccountType,AccountNumber)のいずれかを指定します。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード
ReserveID 半角英数32桁
継続口座ID
BankCode 半角数字4桁
銀行コード
BranchCode 半角数字3桁
支店コード

AccountType 半角数字1桁 固定
預金種別

以下を設定します。
1:普通預金、2:当座預金

AccountNumber 半角数字7桁
口座番号

URL
/payment/InquiryVirtualaccountTransfer.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD
レスポンス

レスポンスボディに以下の形式で出力します。
{InquiryNumber},{SettlementDate},{SettlementAmount},{TradeClientName},{TradeSummary},{TransferStatus}

正常
InquiryNumber 半角数字8桁
照会番号

銀行から返された照会番号を返却します。

SattlementDate 半角数字8桁 固定
勘定日

YYYYMMDD形式

SettlementAmount 半角数字13桁
入金金額

TradeClientName 全半角144バイト
振込依頼人名

TradeSummary 全半角60バイト
摘要

TransferStatus 半角英字32桁
入金状態

入金状態を返却します。
RELATED_ONETIME:取引口座への入金
RELATED_ASSIGN:継続口座への入金
RELATED_FORCE:強制紐付け(取引が有効期限切れ後に入金された場合など、弊社にて入金済み状態の取引を新規作成したことを示します。)
RETURN:振り戻し(入金があったものの、振込者からの依頼で入金を取り消したことを示します。)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
InquiryNumber=12345&SattlementDate=20220801&SettlementAmount=100&TradeClientName=山田太郎&TradeSummary=摘要&TransferStatus=RELATED_ONETIME
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001